Skip to content

Refresh README and docs output examples for v0.2#8

Merged
jimnoneill merged 1 commit into
mainfrom
docs/refresh-output-json-examples
Jul 7, 2026
Merged

Refresh README and docs output examples for v0.2#8
jimnoneill merged 1 commit into
mainfrom
docs/refresh-output-json-examples

Conversation

@jimnoneill

@jimnoneill jimnoneill commented Jul 7, 2026 •
edited by sourcery-ai Bot
Loading

Copy link
Copy Markdown
Contributor

Updates the embedded output examples in the README and architecture docs to match what extraction actually produces:

  • publisher and publicationYear shown as null (platform-owned, set at publish)
  • rightsList removed (stripped from output); publisher dropped from the ROR canonicalisation note and the pipeline-uses list
  • descriptionType shown as Other (set deterministically; no longer asked of the model)
  • affiliation identifier casing corrected to schemeURI
  • formats added (derived from the file extension)
  • architecture caption examples fixed to the {id, caption} shape

Docs only. Patch bump to 0.9.23.

Summary by Sourcery

Align documentation examples and field descriptions with the current extraction behaviour and bump the package patch version.

Enhancements:

  • Clarify behaviour of publisher, publicationYear, descriptionType, rightsList, affiliation identifiers, and formats in README and architecture docs to align with actual extraction output.

Build:

  • Bump package version to 0.9.23.

Documentation:

  • Update README output example and notes to reflect current JSON schema fields and auto-populated values.
  • Refresh architecture documentation examples for ROR enrichment, publisher handling, descriptionType, rights, and caption shapes.

@jimnoneill
docs: align README and architecture output examples with v0.2 (0.9.23)
c5d6626 
Update the embedded output examples to match what extraction actually
produces:
- publisher and publicationYear shown as null (platform-owned, set at publish)
- rightsList removed (stripped from output); publisher dropped from the ROR
  canonicalisation note and the pipeline-uses list
- descriptionType shown as Other (set deterministically; no longer asked of
  the model)
- affiliation identifier casing corrected to schemeURI
- formats added (derived from the file extension)
- architecture caption examples fixed to the {id, caption} shape

Docs only; patch bump to 0.9.23.
@fairdataihub-bot

fairdataihub-bot Bot commented Jul 7, 2026

Copy link
Copy Markdown

Thank you for submitting this pull request! We appreciate your contribution to the project. Before we can merge it, we need to review the changes you've made to ensure they align with our code standards and meet the requirements of the project. We'll get back to you as soon as we can with feedback. Thanks again!

@sourcery-ai

sourcery-ai Bot commented Jul 7, 2026 •
edited
Loading

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates README and architecture docs examples so they align with the current extraction behavior, including null publisher/publicationYear, deterministic descriptionType, removal of rightsList/SPDX mentions, corrected ROR schemeURI casing, added formats, corrected caption shapes, and bumps version to 0.9.23.

Entity relationship diagram for updated poster JSON output fields

erDiagram
  Poster {
    int publicationYear
    json publisher
    string descriptionType
    string formats
  }

  Poster ||--o{ Description : has

  Description {
    string description
    string descriptionType
  }
Loading

File-Level Changes

Change Details Files
Align README example JSON and documentation text with actual extraction output and behavior.
  • Remove publisher canonicalisation and SPDX rights normalization from the pipeline-uses list, limiting ROR usage to affiliations.
  • Update example JSON to set publicationYear and publisher to null, remove rightsList, change descriptionType to Other, and add formats derived from the file extension.
  • Fix affiliation ROR metadata casing from schemeUri to schemeURI in examples.
  • Clarify notes that only affiliation is ROR-enriched, publisher/publicationYear are platform-owned nulls, and formats are inferred from file extension.
 README.md
Refresh architecture docs to describe current enrichment, descriptionType, rights handling, and caption shapes.
  • Change ROR enrichment description to refer to schemeURI instead of schemeUri for affiliations.
  • Replace publisher enrichment section with a statement that publisher is always null and platform-assigned.
  • Document that descriptionType is deterministically set to "Other" and not model-chosen.
  • Document that rightsList is stripped from output instead of SPDX-normalized.
  • Update imageCaptions and tableCaptions examples to the {id, caption} shape.
 docs/architecture.md
Bump package version for docs-only change.
  • Increment Poetry project version from 0.9.22 to 0.9.23.
 pyproject.toml
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@fairdataihub-bot

fairdataihub-bot Bot commented Jul 7, 2026

Copy link
Copy Markdown

Thanks for making updates to your pull request. Our team will take a look and provide feedback as soon as possible. Please wait for any GitHub Actions to complete before editing your pull request. If you have any additional questions or concerns, feel free to let us know. Thank you for your contributions!

sourcery-ai[bot]
sourcery-ai Bot reviewed Jul 7, 2026
View reviewed changes

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • Double-check that the schemeURI casing change matches the actual JSON field name in all code paths and other docs/schema references, so we don't end up with mixed schemeUri/schemeURI usage.
Prompt for AI Agents 
Please address the comments from this code review:

## Overall Comments
- Double-check that the `schemeURI` casing change matches the actual JSON field name in all code paths and other docs/schema references, so we don't end up with mixed `schemeUri`/`schemeURI` usage.
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@jimnoneill jimnoneill merged commit c2aef80 into main Jul 7, 2026
2 checks passed
@fairdataihub-bot

fairdataihub-bot Bot commented Jul 7, 2026

Copy link
Copy Markdown

Thank you for getting this pull request merged. We appreciate your contribution and look forward to your next one!

@jimnoneill jimnoneill deleted the docs/refresh-output-json-examples branch July 7, 2026 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@jimnoneill